sdapplication module¶
-
class
sd.api.sdapplication.SDApplication(APIContext, handle, *args, **kwargs)¶ Bases:
sd.api.sdapiobject.SDAPIObjectRoot object of all objects managed by the API
-
getAppInteropMgr() → Optional[sd.api.sdappinteropmgr.SDAppInteropMgr]¶
-
getClassName() → str¶ Returns the most specific name of the class this APIObject is
-
getColorManagementEngine() → Optional[sd.api.sdcolormanagementengine.SDColorManagementEngine]¶ Get the Color Management Engine
-
getModuleMgr() → sd.api.sdmodulemgr.SDModuleMgr¶ Get the Module Manager
-
getPackageMgr() → Optional[sd.api.sdpackagemgr.SDPackageMgr]¶ Get the Package Manager
-
getPath(sdApplicationPath: sd.api.sdapplication.SDApplicationPath) → str¶ Get the path specified by the SDApplicationPath enum
- Parameters
sdApplicationPath – The enum representing the path to get
-
getPluginMgr() → sd.api.sdpluginmgr.SDPluginMgr¶ Get the Plugin Manager
-
getQtForPythonUIMgr()¶ return …
-
getSDGraphDefinitionMgr() → sd.api.sdgraphdefinitionmgr.SDGraphDefinitionMgr¶ Get the Graph Definition Mgr
-
getSpotColorLibrary() → Optional[sd.api.sdspotcolorlibrary.SDSpotColorLibrary]¶ Get the Spot Color Library
-
getUIMgr() → Optional[sd.api.sduimgr.SDUIMgr]¶ Get the UI Manager
-
getVersion() → str¶ Get the application version as “MAJOR.MINOR.PATCH”
-
registerAfterFileClosedCallback(callable)¶ Register a callback to be called after a file is closed Returns a callback ID that can be used later to unregister the callback
- Parameters
callable (Python function) – Function to call after a file is closed
- Return type
int
-
registerAfterFileLoadedCallback(callable)¶ Register a callback to be called after a file is loaded Returns a callback ID that can be used later to unregister the callback
- Parameters
callable (Python function) – Function to call after a file is loaded
- Return type
int
-
registerAfterFileSavedCallback(callable)¶ Register a callback to be called after a file is saved Returns a callback ID that can be used later to unregister the callback
- Parameters
callable (Python function) – Function to call after a file is saved
- Return type
int
-
registerBeforeFileClosedCallback(callable)¶ Register a callback to be called before a file is closed Returns a callback ID that can be used later to unregister the callback
- Parameters
callable (Python function) – Function to call before a file is closed
- Return type
int
-
registerBeforeFileLoadedCallback(callable)¶ Register a callback to be called before a file is loaded Returns a callback ID that can be used later to unregister the callback
- Parameters
callable (Python function) – Function to call before a file is loaded
- Return type
int
-
registerBeforeFileSavedCallback(callable)¶ Register a callback to be called before a file is saved Returns a callback ID that can be used later to unregister the callback
- Parameters
callable (Python function) – Function to call before a file is saved
- Return type
int
-
release() → None¶ Releases an APIObject
-
unregisterCallback(callbackID)¶ Unregister a callback
- Parameters
callbackID (int) – The callback ID of the callback to unregister
- Return type
None
-
